//
//  YTKNetworkAgent.h
//
//  Copyright (c) 2012-2016 YTKNetwork https://github.com/yuantiku
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.

#import <Foundation/Foundation.h>
#import "YTKBaseRequest.h"

NS_ASSUME_NONNULL_BEGIN


FOUNDATION_EXTERN NSString *const YTKNetworkStatusDidUpdateNotification;

/// 网络类型
typedef NS_ENUM(NSInteger, YTKNetworkStatusType) {
    YTKNetworkStatusUnknown = -1, ///< 未知网络
    YTKNetworkStatusNotReachable, ///< 无网络
    YTKNetworkStatusWWAN, ///< 手机网络
    YTKNetworkStatusWiFi ///< wifi网络
};

@class YTKBaseRequest;

@protocol YTKRequestAppearance <NSObject>

@optional

/// 请求的统一入口回调
+ (void)enrtyForRequest:(__kindof YTKBaseRequest *)requset error:(NSError *__autoreleasing*)error;

/// 收到特定错误码的回调
+ (void)request:(__kindof YTKBaseRequest *)requset didEndWithErrorCode:(NSInteger)code;

@end

///  YTKNetworkAgent is the underlying class that handles actual request generation,
///  serialization and response handling.
@interface YTKNetworkAgent : NSObject

- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;

///  Get the shared agent.
+ (YTKNetworkAgent *)sharedAgent;

+ (void)registerEnrtyForRequest:(Class<YTKRequestAppearance>)cls;

///  Add request to session and start it.
- (void)addRequest:(YTKBaseRequest *)request;

///  Cancel a request that was previously added.
- (void)cancelRequest:(YTKBaseRequest *)request;

///  Cancel all requests that were previously added.
- (void)cancelAllRequests;

///  Return the constructed URL of request.
///
///  @param request The request to parse. Should not be nil.
///
///  @return The result URL.
- (NSString *)buildRequestUrl:(YTKBaseRequest *)request;

/// 网络类型
@property (nonatomic, assign, readonly) YTKNetworkStatusType networkStatus;

//监听网络状态
- (void)monitorNetworkStatusWithBlock:(void(^)(YTKNetworkStatusType type))block;


/// Request serializer type.
@property (nonatomic, assign) YTKRequestSerializerType requestSerializerType;

/// Response serializer type. default `YTKResponseSerializerTypeJSON`
@property (nonatomic, assign) YTKResponseSerializerType responseSerializerType;

/// 请求共有的参数
@property (nonatomic, strong) NSDictionary *requestArgument;

/// 请求收到响应后的统一处理block
- (void)setHandlerForEveryRequest:(void(^)(__kindof YTKBaseRequest *requset, NSError *__autoreleasing*error))handler;
- (void)setHandlerOnOccuringError:(void(^)(__kindof YTKBaseRequest *requset, NSInteger code))handler;


/// 给响应码添加自定义描述
- (void)addLocalizedDescription:(NSString *)desc
                forResponseCode:(NSInteger)code;

/// 请求头
@property (nonatomic, strong) NSDictionary *requestHeaderFields;

/// add header field for all HTTP request
- (void)addValue:(NSString *)value forHeaderField:(NSString *)field;
/// Username and password used for all HTTP request authorization
- (void)setAuthorizationWithUsername:(NSString *)username password:(NSString *)password;

@end

NS_ASSUME_NONNULL_END
